improve reporting suggestion for snapshot skips #14
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@pinzon recently shared a trick regarding snapshot skips path that would contain special characters.
It made me remember a fix I had done before this was even its own library with localstack/localstack#6802, allowing us to use single quote in snapshot skip paths for those special characters.
This PR adds better suggestion by detecting and wrapping part elements that would contain such characters so that users could directly copy paste the snapshot skip path and it would work out of the box, instead of having weird issues.
Luckily there were already tests for the helper function, thanks @dominikschubert 🙏
For example, for this kind of error which would fail if you copy pasted it to skip that path before, this would be the new message: